docs: use markdown instead of <filename> tags
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Mon, 3 Feb 2014 21:34:03 +0000 (16:34 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 4 Feb 2014 21:58:53 +0000 (16:58 -0500)
14 files changed:
gdk/gdkcolor.c
gdk/gdkevents.h
gdk/gdkkeys.c
gtk/deprecated/gtkrc.c
gtk/gtkbindings.c
gtk/gtkbuilder.c
gtk/gtkcssprovider.c
gtk/gtkimcontext.c
gtk/gtkplug.c
gtk/gtksettings.c
gtk/gtkshow.c
gtk/gtksocket.c
gtk/gtkstylecontext.c
gtk/gtkstyleprovider.h

index e2371c93fffef36711defee30bdb110c3bac61eb..4fe82d12066e7b87fe05fc6972e0697d3ad157ee 100644 (file)
@@ -131,7 +131,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
  * @red, @green, and @blue fields of a #GdkColor.
  *
  * The string can either one of a large set of standard names
- * (taken from the X11 <filename>rgb.txt</filename> file), or
+ * (taken from the X11 `rgb.txt` file), or
  * it can be a hex value in the form '&num;rgb' '&num;rrggbb'
  * '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and
  * 'b' are hex digits of the red, green, and blue components
index 8df160bd70117a24c2abd13db506d5c1b0a93406..5ab75c09bcfc5a00a3dbc6adb2442701994910b1 100644 (file)
@@ -791,7 +791,7 @@ struct _GdkEventScroll
  *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
  *   buttons. See #GdkModifierType.
  * @keyval: the key that was pressed or released. See the
- *   <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file for a
+ *   `gdk/gdkkeysyms.h` header file for a
  *   complete list of GDK key codes.
  * @length: the length of @string.
  * @string: a string containing an approximation of the text that
index dbd0a5eb72f296edd5a1d4e85ff9ede1a806fe15..568cf3a0ad908951fb08823cfa4bf5f58b9ed862 100644 (file)
@@ -40,7 +40,7 @@
  * #GdkEventKey structure, which is passed to signal handlers for the
  * #GtkWidget::key-press-event and #GtkWidget::key-release-event signals.
  * The complete list of key values can be found in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file.
+ * `gdk/gdkkeysyms.h` header file.
  *
  * Key values are regularly updated from the upstream X.org X11 implementation,
  * so new values are added regularly. They will be prefixed with GDK_KEY_ rather
@@ -681,7 +681,7 @@ gdk_keymap_get_modifier_mask (GdkKeymap         *keymap,
  * Converts a key value into a symbolic name.
  *
  * The names are the same as those in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
+ * `gdk/gdkkeysyms.h` header file
  * but without the leading "GDK_KEY_".
  *
  * Return value: (transfer none): a string containing the name of the key,
@@ -701,7 +701,7 @@ gdk_keyval_name (guint keyval)
  * Converts a key name to a key value.
  *
  * The names are the same as those in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
+ * `gdk/gdkkeysyms.h` header file
  * but without the leading "GDK_KEY_".
  *
  * Returns: the corresponding key value, or %GDK_KEY_VoidSymbol
index d18ecfedc8ff8a74ac268c893ed53639ce61c779..c35635e0255a9c1842a4ea07d81b722ac15b80a7 100644 (file)
  * file by calling gtk_rc_parse(). In addition to this,
  * certain files will be read at the end of gtk_init().
  * Unless modified, the files looked for will be
- * <filename>&lt;SYSCONFDIR&gt;/gtk-2.0/gtkrc</filename>
- * and <filename>.gtkrc-3.0</filename> in the users home directory.
- * (<filename>&lt;SYSCONFDIR&gt;</filename> defaults to
- * <filename>/usr/local/etc</filename>. It can be changed with the
+ * `SYSCONFDIR/gtk-2.0/gtkrc`
+ * and `.gtkrc-3.0` in the users home directory.
+ * (`SYSCONFDIR` defaults to
+ * `/usr/local/etc`. It can be changed with the
  * <option>--prefix</option> or <option>--sysconfdir</option> options when
  * configuring GTK+.)
  *
  * For each RC file, in addition to the file itself, GTK+ will look for
  * a locale-specific file that will be parsed after the main file.
  * For instance, if `LANG` is set to <literal>ja_JP.ujis</literal>,
- * when loading the default file <filename>~/.gtkrc</filename> then GTK+ looks
- * for <filename>~/.gtkrc.ja_JP</filename> and <filename>~/.gtkrc.ja</filename>,
+ * when loading the default file `~/.gtkrc` then GTK+ looks
+ * for `~/.gtkrc.ja_JP` and `~/.gtkrc.ja`,
  * and parses the first of those that exists.
  *
  * # Pathnames and patterns #
  *
  * # Theme gtkrc files #
  *
- * Theme RC files are loaded first from under the <filename>~/.themes/</filename>,
+ * Theme RC files are loaded first from under the `~/.themes/`,
  * then from the directory from gtk_rc_get_theme_dir(). The files looked at will
- * be <filename>gtk-3.0/gtkrc</filename>.
+ * be `gtk-3.0/gtkrc`.
  *
  * When the application prefers dark themes
  * (see the #GtkSettings:gtk-application-prefer-dark-theme property for details),
- * <filename>gtk-3.0/gtkrc-dark</filename> will be loaded first, and if not present
- * <filename>gtk-3.0/gtkrc</filename> will be loaded.
+ * `gtk-3.0/gtkrc-dark` will be loaded first, and if not present
+ * `gtk-3.0/gtkrc` will be loaded.
  *
  * # Optimizing RC Style Matches #
  *
  *
  * <anchor id="color-format"/>
  * Colors can be specified as a string containing a color name (GTK+ knows
- * all names from the X color database <filename>/usr/lib/X11/rgb.txt</filename>),
+ * all names from the X color database `/usr/lib/X11/rgb.txt`),
  * in one of the hexadecimal forms <literal>#rrrrggggbbbb</literal>,
  * <literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>,
  * or <literal>#rgb</literal>, where <literal>r</literal>,
index 53cb4898543eced55112da2247615121954d97fa..0647491a0754abb25e8fd1c4e58ce7efbf4a66af 100644 (file)
@@ -58,7 +58,7 @@
  * signal emissions on the target widget. Key combinations are strings
  * consisting of an optional #GdkModifierType name and
  * <link linkend="gdk3-Keyboard-Handling">key names</link>
- * such as those defined in <filename>&lt;gdk/gdkkeysyms.h&gt;</filename>
+ * such as those defined in `gdk/gdkkeysyms.h`
  * or returned from gdk_keyval_name(), they have to be parsable by
  * gtk_accelerator_parse(). Specifications of signal emissions consist
  * of a string identifying the signal name, and a list of signal specific
index b5334a93f427ddea9865b71323abd6f76f013885..3e07cbf6bc5611f524cec52fc152e91b00bccfd2 100644 (file)
@@ -65,7 +65,7 @@
  * <firstterm>UI definitions</firstterm> if the context is clear.
  * Do not confuse GtkBuilder UI Definitions with
  * <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which
- * are more limited in scope. It is common to use <filename>.ui</filename>
+ * are more limited in scope. It is common to use `.ui`
  * as the filename extension for files containing GtkBuilder UI
  * definitions.
  * |[
index ce16b53075d86ccdb8b09b23db23e8c25ddfe310..93b2f8482f7c3fa934a89856798ed3b2851a69ae 100644 (file)
  * by setting the gtk-key-bindings style property.
  *
  * Customized key bindings are typically defined in a separate
- * <filename>gtk-keys.css</filename> CSS file and GTK+ loads this file
+ * `gtk-keys.css` CSS file and GTK+ loads this file
  * according to the current key theme, which is defined by the
  * #GtkSettings:gtk-key-theme-name setting.
  *
index 9e0a9eb938f528e8ae10a4645f4a285079637cf5..aab5efa5028b60098c7d0bdec237af1f6d9e23e1 100644 (file)
@@ -91,7 +91,7 @@
  * as specified in the #GtkIMContextInfo array returned by im_module_list().
  *
  * After a new loadable input method module has been installed on the system,
- * the configuration file <filename>gtk.immodules</filename> needs to be
+ * the configuration file `gtk.immodules` needs to be
  * regenerated by <link linkend="gtk-query-immodules-3.0">gtk-query-immodules-3.0</link>,
  * in order for the new input method to become available to GTK+ applications.
  */
index 9390b5a0f353481d7dae658c7ddfc83da090ce40..b93fb78b93ad41616e6e2af941755eb6b1d1a5b5 100644 (file)
@@ -64,7 +64,7 @@
  * The #GtkPlug and #GtkSocket widgets are only available when GTK+
  * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
  * They can only be used on a #GdkX11Display. To use #GtkPlug and
- * #GtkSocket, you need to include the <filename>gtk/gtkx.h</filename>
+ * #GtkSocket, you need to include the `gtk/gtkx.h`
  * header.
  */
 
index f28d7d3402cbb1ec332e82466a066f9e0c567f42..f3a14536be6ef4db9c627c7c3c1dce2354af2c7b 100644 (file)
  * manager that is usually part of the desktop environment, along with
  * utilities that let the user change these settings. In the absence of
  * an Xsettings manager, GTK+ reads default values for settings from
- * <filename>settings.ini</filename> files in
- * <filename>/etc/gtk-3.0</filename>, <filename>$XDG_CONFIG_DIRS/gtk-3.0</filename>
- * and <filename>$XDG_CONFIG_HOME/gtk-3.0</filename>.
+ * `settings.ini` files in
+ * `/etc/gtk-3.0`, `$XDG_CONFIG_DIRS/gtk-3.0`
+ * and `$XDG_CONFIG_HOME/gtk-3.0`.
  * These files must be valid key files (see #GKeyFile), and have
  * a section called Settings. Themes can also provide default values
- * for settings by installing a <filename>settings.ini</filename> file
- * next to their <filename>gtk.css</filename> file.
+ * for settings by installing a `settings.ini` file
+ * next to their `gtk.css` file.
  *
  * Applications can override system-wide settings with
  * gtk_settings_set_string_property(), gtk_settings_set_long_property(),
index 2de66be56dfad0d9fc76ac3ced786840911fd841..0bfb9cb5299f4c77ec1bb27da597063717b32da5 100644 (file)
@@ -37,9 +37,9 @@
  * need to install gvfs to get support for uri schemes such as http://
  * or ftp://, as only local files are handled by GIO itself).
  * Typical examples are
- * - <filename>file:///home/gnome/pict.jpg</filename>
- * - <filename>http://www.gnome.org</filename>
- * - <filename>mailto:me&commat;gnome.org</filename>
+ * - `file:///home/gnome/pict.jpg`
+ * - `http://www.gnome.org`
+ * - `mailto:me&commat;gnome.org`
  * Ideally the timestamp is taken from the event triggering
  * the gtk_show_uri() call. If timestamp is not known you can take
  * %GDK_CURRENT_TIME.
index 15ba2a8d54ee1b5620cd9cdd3db131697cf476e6..ffd50c46d4bc684e444466e9a49992fc33e6ee9f 100644 (file)
  * The #GtkPlug and #GtkSocket widgets are only available when GTK+
  * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
  * They can only be used on a #GdkX11Display. To use #GtkPlug and
- * #GtkSocket, you need to include the <filename>gtk/gtkx.h</filename>
+ * #GtkSocket, you need to include the `gtk/gtkx.h`
  * header.
  */
 
index e6a0aaf744d68adb238a1f88b6783e0d1713264d..dca6ab74c563897e404f2e606987cb1d8bbcc287 100644 (file)
  * to make your style information prevail to the theme's, so you must use
  * a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
  * priority, keep in mind that the user settings in
- * <filename><replaceable>XDG_CONFIG_HOME</replaceable>/gtk-3.0/gtk.css</filename> will
+ * `<replaceable>XDG_CONFIG_HOME</replaceable>/gtk-3.0/gtk.css` will
  * still take precedence over your changes, as it uses the
  * %GTK_STYLE_PROVIDER_PRIORITY_USER priority.
  *
index cb0960ff3bddddcf27c033ab67022ee9202360c3..ef5c3555ce08c6cd55c95ed183be76186b7f1147 100644 (file)
@@ -74,7 +74,7 @@ G_BEGIN_DECLS
  * GTK_STYLE_PROVIDER_PRIORITY_USER:
  *
  * The priority used for the style information from
- * <filename>~/.gtk-3.0.css</filename>.
+ * `~/.gtk-3.0.css`.
  *
  * You should not use priorities higher than this, to
  * give the user the last word.